﻿//Copyright 2008 Kristian Gundry And Rune Juhl-Petersen
//This file is part of Plain.

//Plain is free software: you can redistribute it and/or modify
//it under the terms of the GNU Lesser General Public License as published by
//the Free Software Foundation, either version 3 of the License, or
//any later version.

//Plain is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU Lesser General Public License for more details.

//You should have received a copy of the GNU Lesser General Public License
//along with Plain.  If not, see <http://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.Text;
using System.IO;

namespace Plain.Export{
    /// <summary>
    /// Allows export of a list of data to a format.
    /// </summary>
    /// <typeparam name="T"></typeparam>
    public interface IExporter<T>{
        /// <summary>
        /// Sets the list of object to be used for export
        /// </summary>
        IList<T> Source { set; }
        /// <summary>
        /// Set what fields to export
        /// </summary>
        /// <param name="fields">string list of fields</param>
        /// <returns>The Exporter it self</returns>
        IExporter<T> SetFields(IList<string> fields);
        /// <summary>
        /// Writes export to stream
        /// </summary>
        /// <param name="s">stream to write to</param>
        /// <returns>The stream it self</returns>
        Stream WriteToStream(Stream s);
        /// <summary>
        /// Saves export to a file
        /// </summary>
        /// <param name="filename">filename (path)</param>
        /// <returns>True/False</returns>
        bool Save(string filename);
    }
}
